Repository navigation
Conversation
Add a "Pydantic integration" section to the csp.Struct API page that describes the behaviour added in Point72#428: validating and serializing Structs with pydantic, how underscore fields and types without a pydantic schema are handled, how pydantic serialization differs from to_dict/to_json, csp.Enum validation, and the csp.typing NumPy array annotations. Also document type_adapter() and the use_pydantic argument of from_dict. Fixes Point72#431 Signed-off-by: Laksh Agarwal <lakshagarwal65@gmail.com>
Lotion-3
requested review from
AdamGlustein,
alexddobkin,
robambalu and
svatasoiu
as code owners
November 13, 2026 15:16
Member
|
Thanks for the PR! I've consolidated some docs updates in #795 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #431.
Adds a "Pydantic integration" section to the
csp.StructAPI page, covering the behaviour from #428:type_adapter()or inside aBaseModel;to_dict/to_json(enums,Annotatedserializers, datetime and timedelta formats);csp.Enumvalidation and JSON schema;csp.typing.Numpy1DArray/NumpyNDArrayannotations.It also adds
type_adapter()to the list of struct methods and theuse_pydanticargument tofrom_dict.The outputs shown in the examples were produced with csp 0.19.1 and pydantic 2.14, and
make lint-docspasses.